Skip to content

Scala3 Documentation #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 170 commits into from
Closed

Scala3 Documentation #3

wants to merge 170 commits into from

Conversation

b-studios
Copy link

@b-studios b-studios commented Nov 24, 2020

This PR tracks the progress on migrating several Scala 3 documentation source to docs.scala-lang.org:

Explicit goals are:

  • have one platform and one entry point for the documentation of Scala 3.
  • uniform presentation of Scala 3 as "Scala", nevertheless clearly (visually) distinguish between Scala 2 and Scala 3 content.
  • long term deprecate https://lampepfl.github.io but keep it around for historical reasons and to preserve links.

Notes for Reviewers

  • Please note that the book (scala3-book) is not yet fully done. We only have an early draft that we want to release with M3 and then continuing to improve on. So the most important issue right now wrt the book is technical correctness -- for future revisions ideas on presentation, or examples are of course always welcome.
  • Also regarding the book: everything in the folder getting-started is currently ignored and can be removed for the first release (I deleted it for now)
  • The style of the website changed quite a bite (navigation is language specific), index page, etc. If there is anything that breaks existing pages, which I haven't noticed I need to fix this.
  • The title page has been reorganized and some Scala 2 doc contents have been moved to /scala2. Is that reasonable? Is the link to /scala2 visible enough?

alvinj and others added 30 commits October 4, 2020 16:28
Merge the previous 'overview' branch into 'scala-3'.
@SethTisue
Copy link
Collaborator

LGTM for merge

@b-studios b-studios marked this pull request as ready for review December 18, 2020 22:28
@alvinj
Copy link

alvinj commented Dec 18, 2020

can you check that breaking the lines of blockquotes remains the blockquotes?

Sure, I’ll check. I did it the way I have it in the commit because I did the first one that way, saw that Jekyll rendered it properly in the web page. Then did a few more, saw that they worked, so I kept using that style. But let me double-check, it will just take a few minutes.

I’ll also clear my Jekyll cache to be sure.

Okay, I changed all blockquotes to use the same style.

@b-studios
Copy link
Author

b-studios commented Dec 21, 2020

@alvinj Could you maybe have another look at why-scala-3? I noticed that there was a comment that the hierarchy of the collections is outdated. I commented it out for now.

@b-studios
Copy link
Author

Replaced by scala#1861

@b-studios b-studios closed this Dec 21, 2020
@alvinj
Copy link

alvinj commented Dec 21, 2020

Could you maybe have another look at why-scala-3?

Will do.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

10 participants